FINS Salesforce Customers System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| create-contact-request | Salesforce Contact create mapping |
| lookup-contacts-response | Salesforce Contact to CIM Individual mapping response |
| retrieve-contact-by-id-response | Salesforce Contact to CIM Individual format mapping |
| update-contact-request-for-sf | Salesforce Contact update mapping |
| create-account-contact-relation | Salesforce Create AccountContactRelation mapping |
| CustomerTools | This module provides utility functions and mappings for Customer transformations |
| create-customer-request | |
| retrieve-customer-by-id-response | Salesforce Person Account to CIM Customer format mapping |
| retrieve-related-contacts-by-customerid-response | Salesforce AccountContactRelation mapping to CIM PartyRelatedParty |
| search-customers-response | Salesforce Account to CIM Customer format mapping response |
| update-account-contact-relation | Salesforce Update AccountContactRelation mapping |
| update-customers-request-for-sf | Salesforce Person Account update mapping |
| create-organization-account-request | Salesforce Organization Account create mapping |
| update-organization-account-request-for-sf | Salesforce Organization Account update mapping |
| create-household-request | Salesforce Create Household mapping |
| lookup-households-response | Salesforce Look up Household mapping |
| retrieve-household-by-id-response | Salesforce Retrieve Household mapping |
| update-household-request-for-sf | Salesforce Update Household mapping |
| create-lead-request | Salesforce Create Lead mapping |
| lookup-leads-response | Salesforce Look up Leads mapping |
| retrieve-lead-by-id-response | Salesforce Retrieve Lead mapping |
| update-lead-request-for-sf | Salesforce Update Lead mapping |
| lookup-sf-response | Salesforce Search Opportunity mapping |
| retrieve-opportunity-by-id-response | Salesforce Retrieve Opportunity mapping |
| update-opportunity-request-for-sf | Salesforce Update Opportunity mapping |
create-contact-request
Salesforce Contact create mapping
Source:
./src/main/resources/dwl/contacts/create-contact-request.dwl
Variables
var mdmGlobalContactId
MDM Global Id
var mdmPostalAddressId
Id of ContactPointAddess in MDM
var mdmEmailAddressId
Id of ContactPointEmail in MDM
var mdmPhoneNumberId
Id of ContactPointPhone in MDM
var contactPoints
Id of ContactPointAddess in MDM
var emailAddress
Email Address of Contact.
var phone
Phone Number of the Contact.
var addressInfo
Address of the Contact
Mapping Tables
Maps CIM Individual format to Salesforce Contact Object
| Salesforce Contact | CIM | Description |
|---|---|---|
| Salutation | party.salutation | The salutation of the contact |
| FirstName | party.firstName | The First Name of the contact |
| lastName | party.LastName | The Last Name of the contact |
| BirthDate | party.birthDate | The birth date of the contact |
| Global_Individual_Id__c | externalIds.externalId | The Global ID of the contact in MDM system |
| Global_PostalAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointAddress in MDM system |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointEmail in MDM system |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointPhone in MDM system |
| MailingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the contact |
| MailingCity | party.contactPointAddress.cityName | The mailing city of the contact |
| MailingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the contact |
| MailingState | party.contactPointAddress.stateProvinceName | The contact mailing state |
| MailingCountry | party.contactPointAddress.countryName | The contact mailing country |
| MailingLatitude | party.contactPointAddress.geoLatitude | The contact geo lattitude location |
| MailingLongitude | party.contactPointAddress.geoLongitude | The contact geo logitude location |
| party.ContactPointEmail.emailAddress | The contact email | |
| Phone | party.ContactPointPhone.telephoneNumber | The contact phone Number |
lookup-contacts-response
Salesforce Contact to CIM Individual mapping response
Source:
./src/main/resources/dwl/contacts/lookup-contacts-response.dwl
Functions
fun getFormattedDateTime (toFormat)
Function to get date and time in specific format.
param
toFormatthe value of DateTime to format
return formatting date time string
Mapping Tables
Maps Salesforce Contact to CIM Individual format
| CIM | Salesforce Contact | Description |
|---|---|---|
| id | id | The identifier of the contact in Salesforce |
| salutation | Salutation | The salutation of the contact |
| personName | Name | The name of the contact |
| firstName | FirstName | The first name of the contact |
| lastName | LastName | The Last name of the contact |
| birthDate | Birthdate | The birth date of the contact |
| partyType | Individual | The contact party set as "Individual" |
| contactPointType | ContactPointAddress | contactPointType set as "ContactPointAddress" |
| contactPoints.externalIds.externalId | Global_PostalAddress_Id__c | The postalAddress Global ID to ContactPointAddress |
| id | null | The contactPointAddress id set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| addressLine1 | MailingStreet | The mailing address of the contact |
| cityName | MailingCity | The mailing city of the contact |
| postalCodeText | MailingPostalCode | The contact mailing postal code |
| stateProvinceName | MailingState | The contact state province name |
| countryName | MailingCountry | The country name of the contact |
| geoLatitude | MailingLatitude | The geo-latitude code of the contact |
| geoLongitude | MailingLongitude | The geo-longitude code of the contact |
| geoAccuracy | MailingGeocodeAccuracy | The geo-code accurate location of the contact |
| contactPointType | ContactPointEmail | contactPointType set as "ContactPointEmail" |
| contactPoints.externalIds.externalId | Global_EmailAddress_Id__c | The Email Address Global ID to ContactPointEmail |
| id | null | The contactpoint id set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| emailAddress | The email address of the contact | |
| contactPointType | ContactPointPhone | contactPointType - set as "ContactPointPhone" |
| contactPoints.externalIds.externalId | Global_PhoneNumber_Id__c | The Phone Number Global ID to ContactPointPhone |
| contactPointType | ContactId | The contactpoint id - set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| telephoneNumber | Phone | The phone number of the contact |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Individual_Id__c | The Global ID of the contact in MDM system |
| externalIds.externalIdType | MDM | The externalId Type set as "MDM" |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
| externalIds.status | VALID | The externalId status is set as VALID |
| auditInfo.createdDate | CreatedDate | Timestamp of when the contact was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the contact |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the contact was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the contact |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the contact has been soft-deleted |
retrieve-contact-by-id-response
Salesforce Contact to CIM Individual format mapping
Source:
./src/main/resources/dwl/contacts/retrieve-contact-by-id-response.dwl
Mapping Tables
Maps Salesforce Contact to CIM Individual format
| CIM | Salesforce Contact | Description |
|---|---|---|
| id | id | The identifier of the contact in Salesforce |
| salutation | Salutation | The salutation of the contact |
| personName | Name | The name of the contact |
| firstName | FirstName | The first name of the contact |
| lastName | LastName | The Last name of the contact |
| birthDate | Birthdate | The birth date of the contact |
| partyType | Individual | The contact party set as Individual |
| contactPointType | ContactPointAddress | contactPointType set as ContactPointAddress |
| contactPoints.externalIds.externalId | Global_PostalAddress_Id__c | The postalAddress Global ID to ContactPointAddress |
| id | null | The contactPointAddress id set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| addressLine1 | MailingStreet | The mailing address of the contact |
| cityName | MailingCity | The mailing city of the contact |
| postalCodeText | MailingPostalCode | The contact mailing postal code |
| stateProvinceName | MailingState | The contact state province name |
| countryName | MailingCountry | The country name of the contact |
| geoLatitude | MailingLatitude | The geo-latitude code of the contact |
| geoLongitude | MailingLongitude | The geo-longitude code of the contact |
| geoAccuracy | MailingGeocodeAccuracy | The geo-code accurate location of the contact |
| contactPointType | ContactPointEmail | contactPointType set as ContactPointEmail |
| contactPoints.externalIds.externalId | Global_EmailAddress_Id__c | The Email Address Global ID to ContactPointEmail |
| id | null | The contactpoint id set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| emailAddress | The email address of the contact | |
| contactPointType | ContactPointPhone | contactPointType - set as ContactPointPhone |
| contactPoints.externalIds.externalId | Global_PhoneNumber_Id__c | The Phone Number Global ID to ContactPointPhone |
| contactPointType | ContactId | The contactpoint id - set as null |
| activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| telephoneNumber | Phone | The phone number of the contact |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Individual_Id__c | The Global ID of the contact in MDM system |
| externalIds.externalIdType | MDM | The externalId Type set as MDM |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date |
| externalIds.status | VALID | The externalId status is set as VALID |
| auditInfo.createdDate | CreatedDate | Timestamp of when the contact was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the contact |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the contact was last updated to "yyyy-MM-dd'T'HH:mm:ssz" |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the contact |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the contact has been soft-deleted |
update-contact-request-for-sf
Salesforce Contact update mapping
Source:
./src/main/resources/dwl/contacts/update-contact-request-for-sf.dwl
Variables
var mdmGlobalContactId
MDM Global Id
var mdmPostalAddressId
Id of ContactPointAddess in MDM
var mdmEmailAddressId
Id of ContactPointEmail in MDM
var mdmPhoneNumberId
Id of ContactPointPhone in MDM
var contactPoints
Id of ContactPointAddess in MDM
var emailAddress
Email Address of Contact.
var phone
Phone Number of the Contact.
var addressInfo
Address of the Contact
Mapping Tables
Maps CIM Individual format to Salesforce Contact Object
| Salesforce Contact | CIM | Description |
|---|---|---|
| Id | contactId | The identifier of the contact in Salesforce |
| Salutation | party.salutation | The salutation of the contact |
| FirstName | party.firstName | The First Name of the contact |
| lastName | party.LastName | The Last Name of the contact |
| BirthDate | party.birthDate | The birth date of the contact |
| Global_Individual_Id__c | externalIds.externalId | The Global ID of the contact in MDM system |
| Global_PostalAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointAddress in MDM system |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointEmail in MDM system |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of the ContactPointPhone in MDM system |
| MailingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the contact |
| MailingCity | party.contactPointAddress.cityName | The mailing city of the contact |
| MailingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the contact |
| MailingState | party.contactPointAddress.stateProvinceName | The contact mailing state |
| MailingCountry | party.contactPointAddress.countryName | The contact mailing country |
| MailingLatitude | party.contactPointAddress.geoLatitude | The contact geo lattitude location |
| MailingLongitude | party.contactPointAddress.geoLongitude | The contact geo logitude location |
| party.ContactPointEmail.emailAddress | The contact email | |
| Phone | party.ContactPointPhone.telephoneNumber | The contact phone Number |
create-account-contact-relation
Salesforce Create AccountContactRelation mapping
Source:
./src/main/resources/dwl/customers/create-account-contact-relation.dwl
Variables
var sfRolesMap
Roles in Salesforce to define relationship type between Account and Contact
Mapping Tables
Maps CIM PartyRelatedParty to Salesforce AccountContactRelation
| Salesforce | CIM | Description |
|---|---|---|
| Id | id | The identifier of the AccountContactRelation record in Salesforce |
| AccountId | party.id | The identifier of the associated Account |
| ContactId | relatedParty.id | The identifier of the associated contact |
| Roles | partyRelationshipType | The Relationship type of Account and Contact |
| StartDate | relatedFromDate | The date from which Account and Contact are related |
| EndDate | relatedEndDate | The date till which Account and Contact are related |
CustomerTools
This module provides utility functions and mappings for Customer transformations
Source:
./src/main/resources/dwl/customers/CustomerTools.dwl
Functions
fun getGlobalId (externalIdsArr)
This function filters ExternalIds with ExternalId Type as MDM and returns the first one
return Global ExternalID
fun updateIndividualAddressArr (contactPoints)
This function sets default value for isUsedForBilling flag in the ContactPointAddress array and returns the updated array
fun getMailingAddressArr (contactPoints)
This function filters addresses with isUsedForBilling flag as false
fun getIndividualMailingAddress (contactPoints)
This function gets the MailingAddress from Addresses array
fun getIndividualBillingAddress (contactPoints)
Filter Address with isUsedForBilling as true and return the first record
fun updateIndividualPhonesArr (contactPoints)
This function sets default value for isSMSCapable flag in the ContactPointPhone array and returns the updated array
fun getPhonesArr (contactPoints)
This function filters phone numbers with isSMSCapable flag as false
fun getIndividualPhoneInfo (contactPoints)
This function gets the Phone Info from Phones array
fun getMobilePhoneInfo (contactPoints)
Filter Phone Numbers with isSMSCapable as true and return the first record
fun getCustomerStatus (status)
Function to return appropriate Status that matches to status in Salesforce
param
statusStatus as in MDM
return status equivalent in Salesforce
fun updateOrganizationAddressArr (contactPoints)
This function sets default value for isUsedForBilling and isUsedForShipping flag in the ContactPointAddress array and returns the updated array
fun getOrgBillingAddressArr (contactPoints)
This function filters addresses with isUsedForBilling as true or both isUsedForBilling and isUsedForShipping flags as false
fun getOrgBillingAddress (contactPoints)
This function gets the BillingAddress from Addresses array
fun getOrgShippingAddress (contactPoints)
Filter Address with isUsedForShipping as true and return the first record
fun updateOrganizationPhonesArr (contactPoints)
This function sets default value for isFaxCapable flag in the ContactPointPhone array and returns the updated array
fun getOrgPhonesArr (contactPoints)
This function filters phone numbers with isFaxCapable flag as false
fun getOrgPhoneInfo (contactPoints)
This function gets the Phone Info from Phones array
fun getFaxPhoneInfo (contactPoints)
Filter Phone Numbers with isFaxCapable as true and return the first one record
create-customer-request
Source:
./src/main/resources/dwl/customers/create-customer-request.dwl
Mapping Tables
Maps CIM format to Salesforce Account Object
| Salesforce Person Account | CIM | Description |
|---|---|---|
| Id | customerId | The customer Id from the Uriparams |
| Salutation | party.salutation | The salutation of the customer |
| FirstName | party.firstName | The First Name of the customer |
| lastName | party.LastName | The Last Name of the customer |
| PersonBirthDate | party.birthDate | The birth date of the customer |
| AccountNumber | customerNumber | The customer Account Number |
| Global_Customer_Id__c | externalIds.externalId | The Global ID of the customer when externalIdType matches MDM |
| Global_Party_Id__c | party[0].externalIds.externalId | The Global ID of the party associated with customer when externalIdType matches MDM |
| Global_BillingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has isUsedForBilling flag set to true |
| Global_MailingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has primaryFlag flag set to true |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointEmail when externalIdType matches MDM |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM |
| Global_MobileNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM and isSMSCapable flag set to true |
| FinServStatusc | customerStatus | Status of customer |
| PersonEmail | emailAddress | Email Address of the customer |
| Phone | phone | TelephoneNumber of the customer |
| BillingStreet | billingAddress.addressLine1 | Address Line1 of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingCity | billingAddress.cityName | City Name of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingPostalCode | billingAddress.postalCodeText | Postal Code Text of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingState | billingAddress.stateProvinceName | State Province Name of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingCountry | billingAddress.countryName | CountryName of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingLatitude | billingAddress.geoLatitude | Geo Latitude of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingLongitude | billingAddress.geoLongitude | Geo Longitude of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| PersonMailingStreet | mailingAddress.addressLine1 | Address Line1 of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingCity | mailingAddress.cityName | City Name of ContactPointAddress in MDM that that has primaryFlag flag set true |
| PersonMailingPostalCode | mailingAddress.postalCodeText | Postal Code Text of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingState | mailingAddress.stateProvinceName | State Province Name of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingCountry | mailingAddress.countryName | Country Name of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingLatitude | mailingAddress.geoLatitude | Geo Latitude of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingLongitude | mailingAddress.geoLongitude | Geo Longitude of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMobilePhone | telephoneNumber | Telephone Number of ContactPointPhone in MDM that has isSMSCapable flag set true |
retrieve-customer-by-id-response
Salesforce Person Account to CIM Customer format mapping
Source:
./src/main/resources/dwl/customers/retrieve-customer-by-id-response.dwl
Variables
var isOrgAccount
Validate if the account is organization account
Mapping Tables
Maps Salesforce Account to CIM Customer format The CIM Customer (PartyRole) can have either Individual or Organization as Party. The Salesforce PersonAccount is mapped as a Customer with Party as Individual in CIM. The Salesforce Account is mapped as a Customer with Party as Organization in CIM.
| CIM | Salesforce Person Account | Description |
|---|---|---|
| partyRoleType | Customer | Hardcoded partyrole to customer |
| id | customerId | The customer Id |
| party.id | id | The party Id is hardcoded to null |
| party.salutation | Salutation | The customer salutation |
| party.personName | FirstName ++ LastName | The customer personal name (concatenate FistName + LastName) |
| party.firstName | FirstName | The customer first name |
| party.lastName | LastName | The customer Last name |
| party.birthDate | PersonBirthdate | The customer birth date |
| party.partyType | Record Type | The customer party type returned as Individual or Organization or Household |
| contactPointType | ContactPointAddress | Hardcoded customer contact type to ContactPointAddress |
| contactPoints.externalIds.externalId | Global_PostalAddress_Id__c | The postalAddress Global ID to ContactPointAddress |
| id | PersonContactId | The customer Id |
| activeFromDate | todays date | The customer Active from date is hardcoded to Todays date |
| addressLine1 | PersonMailingStreet | The customers mailing address |
| cityName | PersonMailingCity | The customers mailing city |
| postalCodeText | PersonMailingPostalCode | The customer mailing postal code |
| stateProvinceName | PersonMailingState | The customer state province name |
| countryName | PersonMailingCountry | The customer country name |
| geoLatitude | PersonMailingLatitude | The customer geo-latitude code |
| geoLongitude | PersonMailingLongitude | The customer geo-longitude code |
| geoAccuracy | PersonMailingGeocodeAccuracy | The customer geo-code accurate location |
| contactPointType | ContactPointEmail | Hardcoded customer contact type to ContactPointEmail |
| contactPoints.externalIds.externalId | Global_EmailAddress_Id__c | The Email Address Global ID to ContactPointEmail |
| id | PersonContactId | The customer id |
| activeFromDate | todays date | The customer Active from date is hardcoded to todays date |
| emailAddress | PersonEmail | The customer contact email address |
| contactPointType | ContactPointPhone | Hardcoded customer contact type to ContactPointPhone |
| contactPoints.externalIds.externalId | Global_PhoneNumber_Id__c | The Phone Number Global ID to ContactPointPhone |
| contactPointType | PersonContactId | The customer id |
| activeFromDate | todays date | The customer Active from date is hardcoded to todays date |
| telephoneNumber | Phone | The customer phone number |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Customer_Id__c | The customer Global ID |
| externalIds.externalIdType | MDM | The customer is hardcoded as MDM |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
| externalIds.status | VALID | The customer status is hardcoded as VALID |
| auditInfo.createdDate | CreatedDate | The customer created date to "yyyy-MM-dd'T'HH:mm:ssz" |
| auditInfo.createdBy | CreatedBy.Name | The last created by user name |
| auditInfo.updatedDate | LastModifiedDate | The last updated date to "yyyy-MM-dd'T'HH:mm:ssz" |
| auditInfo.updatedBy | LastModifiedBy.Name | The last modified user name |
| auditInfo.isDeleted | IsDeleted | returns true if user deleted else false |
| customerNumber | AccountNumber | The customer Account Number |
| customerStatus | ACTIVE | Hardcoded as ACTIVE |
retrieve-related-contacts-by-customerid-response
Salesforce AccountContactRelation mapping to CIM PartyRelatedParty
Source:
./src/main/resources/dwl/customers/retrieve-related-contacts-by-customerid-response.dwl
Variables
var cimRelationshipTypesMap
Array to hold Relationship types between Account and Contact
var s
Maps Salesforce AccountContactRelation to CIM PartyRelatedParty
Mapping Tables
Maps Salesforce AccountContactRelation to CIM PartyRelatedParty
| CIM | Salesforce | Description |
|---|---|---|
| id | Id | The identifier of the AccountContactRelation record in Salesforce |
| partyRelationshipType | Roles | The Relationship type of Account and Contact |
| relatedParty.id | ContactId | The identifier of the associated contact |
| partyType | "Individual" | The type of Party set as Individual |
| party.id | AccountId | The identifier of the associated Account |
| partyType | "Organization" | The type of Party set as Organization |
| relatedFromDate | StartDate | The date from which Account and Contact are related |
| relatedEndDate | EndDate | The date till which Account and Contact are related |
search-customers-response
Salesforce Account to CIM Customer format mapping response
Source:
./src/main/resources/dwl/customers/search-customers-response.dwl
Functions
fun isOrgAccount (isPersonAccount)
Function to confirm if the is organization account by checking if its not person account.
param
isPersonAccountflag to confirm person account or not
return flag to confirm the account is organization account or not
Mapping Tables
Maps Salesforce Account to CIM Customer format The CIM Customer (PartyRole) can have either Individual or Organization as Party. The Salesforce PersonAccount is mapped as a Customer with Party as Individual in CIM. The Salesforce Account is mapped as a Customer with Party as Organization in CIM.
| CIM | Salesforce Person Account | Description |
|---|---|---|
| partyRoleType | Customer | Hardcoded partyrole to customer |
| id | customerId | The customer Id |
| party.id | id | The party Id is hardcoded to null |
| party.salutation | Salutation | The customer salutation |
| party.personName | FirstName ++ LastName | The customer personal name (concatenate FistName + LastName) |
| party.firstName | FirstName | The customer first name |
| party.lastName | LastName | The customer Last name |
| party.birthDate | PersonBirthdate | The customer birth date |
| party.partyType | Individual | The customer party type hardcoded as Individual or Organization |
| contactPointType | ContactPointAddress | Hardcoded customer contact type to ContactPointAddress |
| contactPoints.externalIds.externalId | Global_PostalAddress_Id__c | The Postal Address Global ID to ContactPointAddress |
| id | PersonContactId | The customer Id |
| activeFromDate | todays date | The customer Active from date is hardcoded to Todays date |
| addressLine1 | PersonMailingStreet | The customers mailing address |
| cityName | PersonMailingCity | The customers mailing city |
| postalCodeText | PersonMailingPostalCode | The customer mailing postal code |
| stateProvinceName | PersonMailingState | The customer state province name |
| countryName | PersonMailingCountry | The customer country name |
| geoLatitude | PersonMailingLatitude | The customer geo-latitude code |
| geoLongitude | PersonMailingLongitude | The customer geo-longitude code |
| geoAccuracy | PersonMailingGeocodeAccuracy | The customer geo-code accurate location |
| contactPointType | ContactPointEmail | Hardcoded customer contact type to ContactPointEmail |
| contactPoints.externalIds.externalId | Global_EmailAddress_Id__c | The Email Address Global ID to ContactPointEmail |
| id | PersonContactId | The customer id |
| activeFromDate | todays date | The customer Active from date is hardcoded to todays date |
| emailAddress | PersonEmail | The customer contact email address |
| contactPointType | ContactPointPhone | Hardcoded customer contact type to ContactPointPhone |
| contactPoints.externalIds.externalId | Global_PhoneNumber_Id__c | The Phone Number Global ID to ContactPointPhone |
| contactPointType | PersonContactId | The customer id |
| activeFromDate | todays date | The customer Active from date is hardcoded to todays date |
| telephoneNumber | Phone | The customer phone number |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Customer_Id__c | The customer Global ID |
| externalIds.externalIdType | MDM | The customer is hardcoded as MDM |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
| externalIds.status | VALID | The customer status is hardcoded as VALID |
| auditInfo.createdDate | CreatedDate | The customer created date to "yyyy-MM-dd'T'HH:mm:ssz" |
| auditInfo.createdBy | CreatedBy.Name | The last created by user name |
| auditInfo.updatedDate | LastModifiedDate | The last updated date to "yyyy-MM-dd'T'HH:mm:ssz" |
| auditInfo.updatedBy | LastModifiedBy.Name | The last modified user name |
| auditInfo.isDeleted | IsDeleted | returns true if user deleted else false |
| customerNumber | AccountNumber | The customer Account Number |
| customerStatus | ACTIVE | Hardcoded as ACTIVE |
update-account-contact-relation
Salesforce Update AccountContactRelation mapping
Source:
./src/main/resources/dwl/customers/update-account-contact-relation.dwl
Variables
var sfRolesMap
Array to hold Relationship types between Account and Contact used for mapping
Mapping Tables
Maps CIM PartyRelatedParty to Salesforce AccountContactRelation
| Salesforce | CIM | Description |
|---|---|---|
| Id | id | The identifier of the AccountContactRelation record in Salesforce |
| Roles | partyRelationshipType | The Relationship type of Account and Contact |
| StartDate | relatedFromDate | The date from which Account and Contact are related |
| EndDate | relatedEndDate | The date till which Account and Contact are related |
update-customers-request-for-sf
Salesforce Person Account update mapping
Source:
./src/main/resources/dwl/customers/update-customers-request-for-sf.dwl
Mapping Tables
Maps CIM format to Salesforce Account Object
| Salesforce Person Account | CIM | Description |
|---|---|---|
| Id | customerId | The customer Id from the Uriparams |
| Salutation | party.salutation | The salutation of the customer |
| FirstName | party.firstName | The First Name of the customer |
| lastName | party.LastName | The Last Name of the customer |
| PersonBirthDate | party.birthDate | The birth date of the customer |
| AccountNumber | customerNumber | The customer Account Number |
| Global_Customer_Id__c | externalIds.externalId | The Global ID of the customer when externalIdType matches MDM |
| Global_Party_Id__c | party[0].externalIds.externalId | The Global ID of the party associated with customer when externalIdType matches MDM |
| Global_BillingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has isUsedForBilling flag set to true |
| Global_MailingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has primaryFlag flag set to true |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointEmail when externalIdType matches MDM |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM |
| Global_MobileNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM and isSMSCapable flag set to true |
| FinServStatusc | customerStatus | Status of customer |
| PersonEmail | emailAddress | Email Address of the customer |
| Phone | phone | TelephoneNumber of the customer |
| BillingStreet | billingAddress.addressLine1 | Address Line1 of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingCity | billingAddress.cityName | City Name of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingPostalCode | billingAddress.postalCodeText | Postal Code Text of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingState | billingAddress.stateProvinceName | State Province Name of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingCountry | billingAddress.countryName | CountryName of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingLatitude | billingAddress.geoLatitude | Geo Latitude of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| BillingLongitude | billingAddress.geoLongitude | Geo Longitude of ContactPointAddress in MDM that isUsedForBilling flag set to true |
| PersonMailingStreet | mailingAddress.addressLine1 | Address Line1 of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingCity | mailingAddress.cityName | City Name of ContactPointAddress in MDM that that has primaryFlag flag set true |
| PersonMailingPostalCode | mailingAddress.postalCodeText | Postal Code Text of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingState | mailingAddress.stateProvinceName | State Province Name of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingCountry | mailingAddress.countryName | Country Name of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingLatitude | mailingAddress.geoLatitude | Geo Latitude of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMailingLongitude | mailingAddress.geoLongitude | Geo Longitude of ContactPointAddress in MDM that has primaryFlag flag set true |
| PersonMobilePhone | telephoneNumber | Telephone Number of ContactPointPhone in MDM that has isSMSCapable flag set true |
create-organization-account-request
Salesforce Organization Account create mapping
Source:
./src/main/resources/dwl/customers/create-organization-account-request.dwl
Mapping Tables
Maps CIM Customer format to Salesforce Person Account Object
| Salesforce Person Account | CIM | Description |
|---|---|---|
| Name | party.name | The Name of the Organization |
| FirstName | party.firstName | The First Name of the customer |
| lastName | party.LastName | The Last Name of the customer |
| PersonBirthDate | party.birthDate | The birth date of the customer |
| Global_Customer_Id__c | externalIds.externalId | The Global ID of the customer when externalIdType matches MDM |
| Global_BillingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has isUsedForBilling flag set to true |
| Global_ShippingAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM and has isUsedForShipping flag set to true |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointEmail when externalIdType matches MDM |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM |
| Global_FaxNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM and has isFaxCapable flag set to true |
| RecordTypeId | recordTypeId | The Salesforce record Id for creating a customer |
| AccountNumber | customerNumber | The customer Account Number |
| BillingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the customer where isUsedForBilling is set to true for the contact point address |
| BillingCity | party.contactPointAddress.cityName | The mailing city of the customer where isUsedForBilling is set to true for the contact point address |
| BillingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the customer where isUsedForBilling is set to true for the contact point address |
| BillingState | party.contactPointAddress.stateProvinceName | The customer mailing state where isUsedForBilling is set to true for the contact point address |
| BillingCountry | party.contactPointAddress.countryName | The customer mailing country where isUsedForBilling is set to true for the contact point address |
| BillingLatitude | party.contactPointAddress.geoLatitude | The customer geo latitude location where isUsedForBilling is set to true for the contact point address |
| BillingLongitude | party.contactPointAddress.geoLongitude | The customer geo longitude location where isUsedForBilling is set to true for the contact point address |
| ShippingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingCity | party.contactPointAddress.cityName | The mailing city of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingState | party.contactPointAddress.stateProvinceName | The customer mailing state where isUsedForShipping is set to true for the contact point address |
| ShippingCountry | party.contactPointAddress.countryName | The customer mailing country where isUsedForShipping is set to true for the contact point address |
| ShippingLatitude | party.contactPointAddress.geoLatitude | The customer geo latitude location where isUsedForShipping is set to true for the contact point address |
| ShippingLongitude | party.contactPointAddress.geoLongitude | The customer geo longitude location where isUsedForShipping is set to true for the contact point address |
| Fax | party.ContactPointPhone.telephoneNumber | The customer contact phone Number that has isFaxCapable flag set to true |
| Phone | party.ContactPointPhone.telephoneNumber | The customer contact phone Number |
update-organization-account-request-for-sf
Salesforce Organization Account update mapping
Source:
./src/main/resources/dwl/customers/update-organization-account-request-for-sf.dwl
Mapping Tables
Maps CIM format to Salesforce Account Object
| Salesforce Person Account | CIM | Description |
|---|---|---|
| Id | customerId | The customer Id from the Uriparams |
| Salutation | party.salutation | The salutation of the customer |
| FirstName | party.firstName | The First Name of the customer |
| lastName | party.LastName | The Last Name of the customer |
| PersonBirthDate | party.birthDate | The birth date of the customer |
| AccountNumber | customerNumber | The customer Account Number |
| Global_Customer_Id__c | externalIds.externalId | The Global ID of the customer when externalIdType matches MDM |
| Global_PostalAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointAddress when externalIdType matches MDM |
| Global_EmailAddress_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointEmail when externalIdType matches MDM |
| Global_PhoneNumber_Id__c | contactPoints.externalIds.externalId | The Global ID of ContactPointPhone when externalIdType matches MDM |
| BillingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the customer where isUsedForBilling is set to true for the contact point address |
| BillingCity | party.contactPointAddress.cityName | The mailing city of the customer where isUsedForBilling is set to true for the contact point address |
| BillingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the customer where isUsedForBilling is set to true for the contact point address |
| BillingState | party.contactPointAddress.stateProvinceName | The customer mailing state where isUsedForBilling is set to true for the contact point address |
| BillingCountry | party.contactPointAddress.countryName | The customer mailing country where isUsedForBilling is set to true for the contact point address |
| BillingLatitude | party.contactPointAddress.geoLatitude | The customer geo latitude location where isUsedForBilling is set to true for the contact point address |
| BillingLongitude | party.contactPointAddress.geoLongitude | The customer geo longitude location where isUsedForBilling is set to true for the contact point address |
| ShippingStreet | party.contactPointAddress.addressLine1 | The mailing Address of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingCity | party.contactPointAddress.cityName | The mailing city of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingPostalCode | party.contactPointAddress.postalCodeText | The mailing postal code of the customer where isUsedForShipping is set to true for the contact point address |
| ShippingState | party.contactPointAddress.stateProvinceName | The customer mailing state where isUsedForShipping is set to true for the contact point address |
| ShippingCountry | party.contactPointAddress.countryName | The customer mailing country where isUsedForShipping is set to true for the contact point address |
| ShippingLatitude | party.contactPointAddress.geoLatitude | The customer geo latitude location where isUsedForShipping is set to true for the contact point address |
| ShippingLongitude | party.contactPointAddress.geoLongitude | The customer geo longitude location where isUsedForShipping is set to true for the contact point address |
| Fax | party.ContactPointPhone.telephoneNumber | The customer contact phone Number that has isFaxCapable flag set to true |
| Phone | party.ContactPointPhone.telephoneNumber | The customer contact phone Number |
create-household-request
Salesforce Create Household mapping
Source:
./src/main/resources/dwl/households/create-household-request.dwl
Mapping Tables
Maps Salesforce Account object to CIM Household format
| Salesforce Account | CIM | Description |
|---|---|---|
| RecordTypeId | Household | The Id of RecordType Household in Salesforce |
| Name | name | The Name of the household in Salesforce |
| Global_Party_Id__c | externalIdType | The global party identifier in MDM |
lookup-households-response
Salesforce Look up Household mapping
Source:
./src/main/resources/dwl/households/lookup-households-response.dwl
Mapping Tables
Maps Salesforce Account to CIM Household format
| CIM - Household | Salesforce - Account | Description |
|---|---|---|
| id | id | The identifier of the household in Salesforce |
| name | Name | The name of the household in Salesforce |
| householdFormedDate | CreatedDate | The name of the household in Salesforce |
| householdMemberCount | Lookup Household Member | The count of related accounts in FinServAccountAccountRelationc object |
| householdDissolvedDate | LastModifiedDate | The name of the household in Salesforce when Status is 'Closed' |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Party_Id__c | The party Global ID |
| externalIds.externalIdType | MDM | The type is hardcoded as MDM |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
| externalIds.status | VALID | The household status is hardcoded as VALID |
retrieve-household-by-id-response
Salesforce Retrieve Household mapping
Source:
./src/main/resources/dwl/households/retrieve-household-by-id-response.dwl
Mapping Tables
Maps Salesforce Account to CIM Household format
| CIM - Household | Salesforce - Account | Description |
|---|---|---|
| id | id | The identifier of the household in Salesforce |
| name | Name | The name of the household in Salesforce |
| householdFormedDate | CreatedDate | The name of the household in Salesforce |
| householdMemberCount | Lookup Household Member | The count of related accounts in FinServAccountAccountRelationc object |
| householdDissolvedDate | LastModifiedDate | The name of the household in Salesforce when Status is 'Closed' |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
| externalIds.id | id | Id field is hardcoded as empty string |
| externalIds.externalId | Global_Party_Id__c | The party Global ID |
| externalIds.externalIdType | MDM | The type is hardcoded as MDM |
| externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
| externalIds.status | VALID | The household status is hardcoded as VALID |
update-household-request-for-sf
Salesforce Update Household mapping
Source:
./src/main/resources/dwl/households/update-household-request-for-sf.dwl
Mapping Tables
Maps Salesforce Account object to Cim Household format
| Salesforce Account | CIM | Description |
|---|---|---|
| RecordTypeId | Household | The Id of RecordType Household in Salesforce |
| Name | name | The Name of the household in Salesforce |
| Global_Party_Id__c | externalIdType | The global party identifier in MDM |
create-lead-request
Salesforce Create Lead mapping
Source:
./src/main/resources/dwl/leads/create-lead-request.dwl
Mapping Tables
Maps CIM Lead format to Salesforce Lead Object
| Salesforce Lead | CIM | Description |
|---|---|---|
| RecordTypeId | Lead | The Id of RecordType Lead in Salesforce |
| Salutation | partyRole.party.salutation | The salutation of the lead |
| FirstName | partyRole.party.firstName | The First Name of the lead |
| lastName | partyRole.party.LastName | The Last Name of the lead |
| Street | contactAddress.addressLine1 | The mailing Address of the lead |
| City | contactAddress.cityName | The mailing city of the lead |
| PostalCode | contactAddress.postalCodeText | The postal code of the lead |
| State | contactAddress.stateProvinceName | The lead state |
| Country | contactAddress.countryName | The lead country |
| Latitude | contactAddress.geoLatitude | The lead geo lattitude location |
| Longitude | contactAddress.geoLongitude | The lead geo logitude location |
| contactPointEmail.emailAddress | The lead email | |
| Phone | mobileContactPhone | The lead phone Number |
| LeadSource | leadSource | The lead phone Number |
| IsConverted | isConverted | Flag to indicate whether the lead is converted |
| ConvertedAccountId | convertedToAccount | The Id of the Account when the lead is converted |
| Status | leadStatus | The lead status |
| Description | description | The lead description |
| Company | companyName | The lead company name |
| AnnualRevenue | annualRevenue | The lead Annual Revenue |
| LastActivityDate | lastActivityDate | The timestamp of when the lead was last active |
lookup-leads-response
Salesforce Look up Leads mapping
Source:
./src/main/resources/dwl/leads/lookup-leads-response.dwl
Mapping Tables
Maps Salesforce Lead to CIM Lead format
| CIM - Lead | Salesforce - Lead | Description |
|---|---|---|
| id | id | The identifier of the lead in Salesforce |
| leadSource | LeadSource | The lead source - default set as "Marketing Event" |
| convertedToAccount | ConvertedAccountId | The Id of the Account when the lead is converted |
| leadStatus | Status | The lead status |
| description | Description | The lead description |
| companyName | Company | The lead company name |
| annualRevenue | AnnualRevenue | The lead Annual Revenue |
| lastActivityDate | LastActivityDate | The timestamp of when the lead was last active |
| Salutation | salutation | The salutation of the lead |
| Name | partyRole.party.personName | The name of the lead |
| FirstName | partyRole.party.firstName | The first name of the lead |
| LastName | partyRole.party.lastName | The Last name of the lead |
| partyType | Individual | The lead party set as "Individual" |
| contactAddress.contactPointType | ContactPointAddress | contactPointType set as "ContactPointAddress" |
| contactAddress.id | null | The contactPointAddress id set as null |
| contactAddress.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| contactAddress.addressLine1 | Street | The mailing address of the lead |
| contactAddress.cityName | City | The mailing city of the lead |
| contactAddress.postalCodeText | PostalCode | The lead mailing postal code |
| contactAddress.stateProvinceName | State | The lead state province name |
| contactAddress.countryName | Country | The country name of the lead |
| contactAddress.geoLatitude | Latitude | The geo-latitude code of the lead |
| contactAddress.geoLongitude | Longitude | The geo-longitude code of the lead |
| contactPointEmail.contactPointType | ContactPointEmail | contactPointType set as "ContactPointEmail" |
| contactPointEmail.id | null | The contactpoint id set as null |
| contactPointEmail.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| contactPointEmail.emailAddress | The email address of the lead | |
| mobileContactPhone.contactPointType | ContactPointPhone | contactPointType - set as "ContactPointPhone" |
| mobileContactPhone.id | null | The contactpoint id - set as null |
| mobileContactPhone.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| mobileContactPhone.telephoneNumber | Phone | The phone number of the lead |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
retrieve-lead-by-id-response
Salesforce Retrieve Lead mapping
Source:
./src/main/resources/dwl/leads/retrieve-lead-by-id-response.dwl
Mapping Tables
Maps Salesforce Lead to CIM Lead format
| CIM - Lead | Salesforce - Lead | Description |
|---|---|---|
| id | id | The identifier of the lead in Salesforce |
| leadSource | LeadSource | The lead source - default set as "Marketing Event" |
| convertedToAccount | ConvertedAccountId | The Id of the Account when the lead is converted |
| leadStatus | Status | The lead status |
| description | Description | The lead description |
| companyName | Company | The lead company name |
| annualRevenue | AnnualRevenue | The lead Annual Revenue |
| lastActivityDate | LastActivityDate | The timestamp of when the lead was last active |
| Salutation | salutation | The salutation of the lead |
| Name | partyRole.party.personName | The name of the lead |
| FirstName | partyRole.party.firstName | The first name of the lead |
| LastName | partyRole.party.lastName | The Last name of the lead |
| partyType | Individual | The lead party set as "Individual" |
| contactAddress.contactPointType | ContactPointAddress | contactPointType set as "ContactPointAddress" |
| contactAddress.id | null | The contactPointAddress id set as null |
| contactAddress.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| contactAddress.addressLine1 | Street | The mailing address of the lead |
| contactAddress.cityName | City | The mailing city of the lead |
| contactAddress.postalCodeText | PostalCode | The lead mailing postal code |
| contactAddress.stateProvinceName | State | The lead state province name |
| contactAddress.countryName | Country | The country name of the lead |
| contactAddress.geoLatitude | Latitude | The geo-latitude code of the lead |
| contactAddress.geoLongitude | Longitude | The geo-longitude code of the lead |
| contactPointEmail.contactPointType | ContactPointEmail | contactPointType set as "ContactPointEmail" |
| contactPointEmail.id | null | The contactpoint id set as null |
| contactPointEmail.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| contactPointEmail.emailAddress | The email address of the lead | |
| mobileContactPhone.contactPointType | ContactPointPhone | contactPointType - set as "ContactPointPhone" |
| mobileContactPhone.id | null | The contactpoint id - set as null |
| mobileContactPhone.activeFromDate | now() | The date from which the contactpoint is active - Set as current date |
| mobileContactPhone.telephoneNumber | Phone | The phone number of the lead |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
update-lead-request-for-sf
Salesforce Update Lead mapping
Source:
./src/main/resources/dwl/leads/update-lead-request-for-sf.dwl
Mapping Tables
Maps CIM Lead format to Salesforce Lead Object
| Salesforce Lead | CIM | Description |
|---|---|---|
| Id | id | The Id of the Lead in Salesforce |
| Salutation | partyRole.party.salutation | The salutation of the lead |
| FirstName | partyRole.party.firstName | The First Name of the lead |
| lastName | partyRole.party.LastName | The Last Name of the lead |
| Street | contactAddress.addressLine1 | The mailing Address of the lead |
| City | contactAddress.cityName | The mailing city of the lead |
| PostalCode | contactAddress.postalCodeText | The postal code of the lead |
| State | contactAddress.stateProvinceName | The lead state |
| Country | contactAddress.countryName | The lead country |
| Latitude | contactAddress.geoLatitude | The lead geo lattitude location |
| Longitude | contactAddress.geoLongitude | The lead geo logitude location |
| contactPointEmail.emailAddress | The lead email | |
| Phone | mobileContactPhone | The lead phone Number |
| LeadSource | leadSource | The lead source |
| ConvertedAccountId | convertedToAccount | The Id of the Account when the lead is converted |
| Status | leadStatus | The lead status |
| Description | description | The lead description |
| Company | companyName | The lead company name |
| AnnualRevenue | annualRevenue | The lead Annual Revenue |
| LastActivityDate | lastActivityDate | The timestamp of when the lead was last active |
lookup-sf-response
Salesforce Search Opportunity mapping
Source:
./src/main/resources/dwl/opportunities/lookup-sf-response.dwl
Mapping Tables
Maps Salesforce Lead to CIM Lead format
| CIM - Opportunitu | Salesforce - Opportunity | Description |
|---|---|---|
| id | id | The identifier of the opportunity in Salesforce |
| partyType | "Opportunity" | The partyType in CIM is Opportunity |
| name | Name | The name of the Opportunity in Salesforce |
| firstName | FirstName | First Name of the Account associated with Opportunity |
| lastName | LastName | Last Name of the Account associated with Opportunity |
| personName | Name | Person Name of the Account associated with Opportunity |
| amount | Amount | The amount mentioned in Salesforce |
| opportunityType | Type | The type of opportunity in Salesforce |
| closeDate | CloseDate | The date on which the opportunity is closed |
| stageName | StageName | Current stage of the Opportunity |
| isClosed | IsClosed | Is the opportunity closed |
| isWon | IsWon | Is the opportunity won |
| primaryAccount | AccountId | Account associated with the opportunity |
| achTransferAuthDocumentId | Ach Transfer Auth Document Id | Ach Transfer Document Id associated with opportunity |
| assetTransferAuthDocumentId | Ach Transfer Auth Document Id | Asset Transfer Document Id associated with opportunity |
| hasAllDocumentSignatures | Document Signatures Received | Flag to indicate if all Signatures have been received for the Documents |
| hasKnowledgeCheckPassed | KYC Completed | Flag to indicate if KYC Checked have been completed |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
retrieve-opportunity-by-id-response
Salesforce Retrieve Opportunity mapping
Source:
./src/main/resources/dwl/opportunities/retrieve-opportunity-by-id-response.dwl
Mapping Tables
Maps Salesforce Lead to CIM Lead format
| CIM - Opportunitu | Salesforce - Opportunity | Description |
|---|---|---|
| id | id | The identifier of the opportunity in Salesforce |
| partyType | "Opportunity" | The partyType in CIM is Opportunity |
| name | Name | The name of the opportunity in Salesforce |
| firstName | FirstName | First Name of the Account associated with Opportunity |
| lastName | LastName | Last Name of the Account associated with Opportunity |
| personName | Name | Person Name of the Account associated with Opportunity |
| amount | Amount | The amount mentioned in Salesforce |
| opportunityType | Type | The type of opportunity in Salesforce |
| closeDate | CloseDate | The date on which the opportunity is closed |
| stageName | StageName | Current stage of the opportunity |
| isClosed | IsClosed | Is the opportunity closed |
| isWon | IsWon | Is the opportunity won |
| primaryAccount | AccountId | Account associated with the opportunity |
| achTransferAuthDocumentId | Ach Transfer Auth Document Id | Ach Transfer Document Id associated with opportunity |
| assetTransferAuthDocumentId | Ach Transfer Auth Document Id | Asset Transfer Document Id associated with opportunity |
| hasAllDocumentSignatures | Document Signatures Received | Flag to indicate if all Signatures have been received for the Documents |
| hasKnowledgeCheckPassed | KYC Completed | Flag to indicate if KYC Checked have been completed |
| contactPoints | Account.Contact | Contacts related to the Account associated with the opportunity |
| auditInfo.createdDate | CreatedDate | Timestamp of when the lead was created |
| auditInfo.createdBy | CreatedBy.Name | Identifies the system or user which created the lead |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the lead was last updated |
| auditInfoupdatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the lead |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the lead has been soft-deleted |
update-opportunity-request-for-sf
Salesforce Update Opportunity mapping
Source:
./src/main/resources/dwl/opportunities/update-opportunity-request-for-sf.dwl
Mapping Tables
Maps CIM Opportunity to Salesforce Opportunity format
| Salesforce - Opportunity | CIM - Opportunity | Description |
|---|---|---|
| id | id | The identifier of the opportunity in Salesforce |
| Name | name | The name of the Opportunity in Salesforce |
| Amount | amount | The amount mentioned in Salesforce |
| Type | opportunityType | The type of opportunity in Salesforce |
| CloseDate | closeDate | The date on which the opportunity is closed |
| StageName | stageName | Current stage of the Opportunity |
| Ach Transfer Auth Document Id | achTransferAuthDocumentId | Ach Transfer Document Id associated with opportunity |
| Ach Transfer Auth Document Id | assetTransferAuthDocumentId | Asset Transfer Document Id associated with opportunity |
| Document Signatures Received | hasAllDocumentSignatures | Flag to indicate if all Signatures have been received for the Documents |
| KYC Completed | hasKnowledgeCheckPassed | Flag to indicate if KYC Checked have been completed |